API Documentation
ThreadSubmittedWork.h
1 // ThreadSubmittedWork.h
3 //
5 
6 namespace nkTasks
7 {
11  class DLL_TASKS_EXPORT ThreadSubmittedWork final
12  {
13  public :
14 
22  ThreadSubmittedWork (Task* task, size_t taskId, Thread* parentThread) ;
31 
32  // Getters
36  Task* getTask () const ;
40  size_t getTaskId () const ;
44  Thread* getParentThread () const ;
45 
51  bool cancel () ;
52 
56  bool operator== (const ThreadSubmittedWork& other) const ;
57  } ;
58 }
nkTasks::ThreadSubmittedWork::getTaskId
size_t getTaskId() const
nkTasks::ThreadSubmittedWork::ThreadSubmittedWork
ThreadSubmittedWork(const ThreadSubmittedWork &other)
nkTasks::Thread
Symbolizes a thread. Base block to submit off-thread nkTasks::Task in this component.
Definition: Thread.h:12
nkTasks::ThreadSubmittedWork
Encompasses all needed information and control over a task that has been submitted.
Definition: ThreadSubmittedWork.h:12
nkTasks::ThreadSubmittedWork::~ThreadSubmittedWork
~ThreadSubmittedWork()
nkTasks::Task
A task, job that can be submitted to a nkTasks::Thread.
Definition: Task.h:14
nkTasks::ThreadSubmittedWork::ThreadSubmittedWork
ThreadSubmittedWork(Task *task, size_t taskId, Thread *parentThread)
nkTasks
Encompasses all API of component NilkinsTasks.
Definition: LogManager.h:7
nkTasks::ThreadSubmittedWork::getParentThread
Thread * getParentThread() const
nkTasks::ThreadSubmittedWork::getTask
Task * getTask() const
nkTasks::ThreadSubmittedWork::cancel
bool cancel()